package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.SchemeTemplateItemAddDTO;
import org.jsola.hr.dto.SchemeTemplateItemUpdateDTO;
import org.jsola.hr.query.SchemeTemplateItemQuery;
import org.jsola.hr.vo.SchemeTemplateItemListVO;
import org.jsola.hr.vo.SchemeTemplateItemVO;

import java.util.List;

/**
 * 参保方案模板子项
 *
 * @author zhr
 */
@Api(tags = "hr-参保方案模板子项")
public interface ISchemeTemplateItemControllerAPI {

    /**
     * 新增参保方案模板子项
     * @param schemeTemplateItemAddDTO 参保方案模板子项新增实体
     * @return 参保方案模板子项展示对象
     */
    @ApiOperation(value = "新增参保方案模板子项")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "schemeTemplateItemAddDTO", dataType = "SchemeTemplateItemAddDTO", value = "新增参保方案模板子项", paramType = "body")
    })
    Result<SchemeTemplateItemVO> save(SchemeTemplateItemAddDTO schemeTemplateItemAddDTO);


    /**
     * 修改参保方案模板子项
     * @param schemeTemplateItemUpdateDTO 参保方案模板子项
     * @return 更新数量
     */
    @ApiOperation(value = "修改参保方案模板子项")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "schemeTemplateItemUpdateDTO", dataType = "SchemeTemplateItemUpdateDTO", value = "修改参保方案模板子项", paramType = "body")
    })
    Result<Integer> update(SchemeTemplateItemUpdateDTO schemeTemplateItemUpdateDTO);




    /**
     * 删除单个参保方案模板子项，彻底删除
     * @param schemeTemplateItemId 参保方案模板子项id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个参保方案模板子项，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "schemeTemplateItemId", dataType = "String", value = "参保方案模板子项id", paramType = "path")
    })
    Result<Integer> delete(String schemeTemplateItemId);


    /**
     * 批量删除参保方案模板子项，彻底删除
     * @param schemeTemplateItemIds 参保方案模板子项id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除参保方案模板子项，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "schemeTemplateItemIds", dataType = "String[]", value = "参保方案模板子项id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] schemeTemplateItemIds);


    /**
     * 根据参保方案模板子项id查询参保方案模板子项详情
     * @param schemeTemplateItemId 参保方案模板子项id
     * @return 参保方案模板子项详情
     */
    @ApiOperation(value="根据参保方案模板子项id查询参保方案模板子项详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "schemeTemplateItemId", dataType = "String", value = "参保方案模板子项id", paramType = "path")
    })
    Result<SchemeTemplateItemVO> findById(String schemeTemplateItemId);


    /**
     * 查询参保方案模板子项
     * @param schemeTemplateItemQuery 参保方案模板子项查询参数
     * @return page
     */
    @ApiOperation(value="查询参保方案模板子项")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "schemeTemplateItemQuery", dataType = "SchemeTemplateItemQuery", value = "参保方案模板子项查询参数", paramType = "query")
    })
    Result<List<SchemeTemplateItemListVO>> listAll(SchemeTemplateItemQuery schemeTemplateItemQuery);


     /**
     * 分页查询参保方案模板子项
     * @param schemeTemplateItemQuery 参保方案模板子项查询参数
     * @return page
     */
    @ApiOperation(value="分页查询参保方案模板子项")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "schemeTemplateItemQuery", dataType = "SchemeTemplateItemQuery", value = "参保方案模板子项查询参数", paramType = "query")
    })
    Result<Page<SchemeTemplateItemListVO>> page(SchemeTemplateItemQuery schemeTemplateItemQuery);


}

